<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Protocols  Reference</title>
    <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="css/highlight.css" />
    <meta charset='utf-8'>
    <script src="js/jquery.min.js" defer></script>
    <script src="js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a title="Protocols  Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="index.html">Contentful Docs</a> (72% documented)</p>
        <p class="header-right"><a href="https://github.com/contentful/contentful.swift"><img src="img/gh.png"/>View on GitHub</a></p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="index.html">Contentful Reference</a>
        <img id="carat" src="img/carat.png" />
        Protocols  Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Classes/Asset.html">Asset</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/Asset/FileMetadata.html">– FileMetadata</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/AssetQuery.html">AssetQuery</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/Client.html">Client</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes.html#/s:C10Contentful12ContentModel">ContentModel</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/ContentType.html">ContentType</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/ContentfulError.html">ContentfulError</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes.html#/s:C10Contentful5Entry">Entry</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/FilterQuery.html">FilterQuery</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/Locale.html">Locale</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/LocalizableResource.html">LocalizableResource</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes.html#/s:C10Contentful19LocalizationContext">LocalizationContext</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/Query.html">Query</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/QueryOn.html">QueryOn</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/RateLimitError.html">RateLimitError</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/Resource.html">Resource</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/Space.html">Space</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/SyncSpace.html">SyncSpace</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/SysISO8601DateTransform.html">SysISO8601DateTransform</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Enums.html">Enums</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Enums/Bounds.html">Bounds</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/FieldType.html">FieldType</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Fit.html">Fit</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Focus.html">Focus</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Format.html">Format</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/ImageOption.html">ImageOption</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/JPGQuality.html">JPGQuality</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Link.html">Link</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/MimetypeGroup.html">MimetypeGroup</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/QueryError.html">QueryError</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/QueryOperation.html">QueryOperation</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/SDKError.html">SDKError</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Extensions/Date.html">Date</a>
              </li>
              <li class="nav-group-task">
                <a href="Extensions/Date/Formatter.html">– Formatter</a>
              </li>
              <li class="nav-group-task">
                <a href="Extensions/Dictionary.html">Dictionary</a>
              </li>
              <li class="nav-group-task">
                <a href="Extensions/Int.html">Int</a>
              </li>
              <li class="nav-group-task">
                <a href="Extensions/String.html">String</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Functions.html">Functions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Functions.html#/s:F10Contentfuloi2eeFTCS_8ResourceS0__Sb">==(_:_:)</a>
              </li>
              <li class="nav-group-task">
                <a href="Functions.html#/s:F10Contentfuloi2eeFTOS_11ImageOptionS0__Sb">==(_:_:)</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Protocols/AbstractQuery.html">AbstractQuery</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/ChainableQuery.html">ChainableQuery</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/ContentModellable.html">ContentModellable</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/EntryModellable.html">EntryModellable</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/Integration.html">Integration</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/PersistenceIntegration.html">PersistenceIntegration</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/QueryableRange.html">QueryableRange</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/SpaceModellable.html">SpaceModellable</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Structs.html">Structs</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Structs/ArrayResponse.html">ArrayResponse</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/ClientConfiguration.html">ClientConfiguration</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/Field.html">Field</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/LinkSys.html">LinkSys</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/MappedArrayResponse.html">MappedArrayResponse</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/MappedContent.html">MappedContent</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/OrderParameter.html">OrderParameter</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs.html#/s:V10Contentful14QueryParameter">QueryParameter</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/Sys.html">Sys</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Typealiases.html">Typealiases</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:10Contentful14ResultsHandler">ResultsHandler</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:10Contentful14TaskObservable">TaskObservable</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>Protocols</h1>
            <p>The following protocols are available globally.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:P10Contentful22PersistenceIntegration"></a>
                    <a name="//apple_ref/swift/Protocol/PersistenceIntegration" class="dashAnchor"></a>
                    <a class="token" href="#/s:P10Contentful22PersistenceIntegration">PersistenceIntegration</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Conform to this protocol and initialize your <code><a href="Classes/Client.html">Client</a></code> instance with the <code>persistenceIntegration</code> 
initialization parameter set to recieve messages about creation and deletion of <code><a href="Classes.html#/s:C10Contentful5Entry">Entry</a></code>s and <code><a href="Classes/Asset.html">Asset</a></code>s 
in your space when doing sync operations using the <code>Client.initialSync()</code> and Client.nextSync()<code>methods.
Proper conformance to this protocol should enable persisting the state changes that happen in your Contentful
space to a persistent store such as</code>CoreData`.</p>

                        <a href="Protocols/PersistenceIntegration.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">PersistenceIntegration</span><span class="p">:</span> <span class="kt"><a href="Protocols/Integration.html">Integration</a></span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/contentful/contentful.swift/tree//Sources/Persistence.swift#L18-L102">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:P10Contentful11Integration"></a>
                    <a name="//apple_ref/swift/Protocol/Integration" class="dashAnchor"></a>
                    <a class="token" href="#/s:P10Contentful11Integration">Integration</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>The <code>Integration</code> protocol describes the libary name and version number for external integrations
to be used in conjunction with the contentful.swift SDK.</p>

                        <a href="Protocols/Integration.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Integration</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/contentful/contentful.swift/tree//Sources/ClientConfiguration.swift#L21-L28">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:P10Contentful14QueryableRange"></a>
                    <a name="//apple_ref/swift/Protocol/QueryableRange" class="dashAnchor"></a>
                    <a class="token" href="#/s:P10Contentful14QueryableRange">QueryableRange</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Use types that conform to QueryableRange to perform queries with the four Range operators
See: <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters/ranges">https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters/ranges</a></p>

                        <a href="Protocols/QueryableRange.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">QueryableRange</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/contentful/contentful.swift/tree//Sources/Query.swift#L52-L55">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:P10Contentful13AbstractQuery"></a>
                    <a name="//apple_ref/swift/Protocol/AbstractQuery" class="dashAnchor"></a>
                    <a class="token" href="#/s:P10Contentful13AbstractQuery">AbstractQuery</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                        <a href="Protocols/AbstractQuery.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/contentful/contentful.swift/tree//Sources/Query.swift#L193-L201">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:P10Contentful14ChainableQuery"></a>
                    <a name="//apple_ref/swift/Protocol/ChainableQuery" class="dashAnchor"></a>
                    <a class="token" href="#/s:P10Contentful14ChainableQuery">ChainableQuery</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Protocol which enables concrete query implementations to be &lsquo;chained&rsquo; together so that results
can be filtered by more than one QueryOperation or other query. Protocol extensions give default implementation
so that all concrete types, <code><a href="Classes/Query.html">Query</a></code>, <code><a href="Classes/AssetQuery.html">AssetQuery</a></code>, <code><a href="Classes/FilterQuery.html">FilterQuery</a></code>, and <code><a href="Classes/QueryOn.html">QueryOn&lt;EntryType&gt;</a></code>, can use the same implementation.</p>

                        <a href="Protocols/ChainableQuery.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ChainableQuery</span><span class="p">:</span> <span class="kt"><a href="Protocols/AbstractQuery.html">AbstractQuery</a></span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/contentful/contentful.swift/tree//Sources/Query.swift#L249">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:P10Contentful17ContentModellable"></a>
                    <a name="//apple_ref/swift/Protocol/ContentModellable" class="dashAnchor"></a>
                    <a class="token" href="#/s:P10Contentful17ContentModellable">ContentModellable</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                        <a href="Protocols/ContentModellable.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/contentful/contentful.swift/tree//Sources/ContentModellable.swift#L13-L15">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:P10Contentful15SpaceModellable"></a>
                    <a name="//apple_ref/swift/Protocol/SpaceModellable" class="dashAnchor"></a>
                    <a class="token" href="#/s:P10Contentful15SpaceModellable">SpaceModellable</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                        <a href="Protocols/SpaceModellable.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/contentful/contentful.swift/tree//Sources/ContentModellable.swift#L17-L20">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:P10Contentful15EntryModellable"></a>
                    <a name="//apple_ref/swift/Protocol/EntryModellable" class="dashAnchor"></a>
                    <a class="token" href="#/s:P10Contentful15EntryModellable">EntryModellable</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                        <a href="Protocols/EntryModellable.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/contentful/contentful.swift/tree//Sources/ContentModellable.swift#L22-L26">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2017 <a class="link" href="https://www.contentful.com" target="_blank" rel="external">Contentful</a>. All rights reserved. (Last updated: 2017-07-31)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
